home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format CD 3 / Amiga Format CD03 (1996-07-04)(Future Publishing)(GB)(Track 1 of 6)[!][issue 1996-08].iso / comms / netsoftware / amigafaces.readme < prev    next >
Text File  |  1996-05-20  |  4KB  |  123 lines
  1. Short:    Universal mail notifier for SMTP and UUCP
  2. Author:   oesi@paradis.rhein.de (Andreas S. Oesterhelt)
  3. Uploader: oesi@paradis.rhein.de (Andreas S. Oesterhelt)
  4. Type:     comm/net, comm/mail
  5.  
  6. Rather than write a new description, I'll include the man page:
  7.  
  8.  
  9. AmigaFaces                                AmigaFaces
  10.  
  11.  
  12. NAME
  13.  
  14.     AmigaFaces 1.0 - Universal mail notifier for UUCP and SMTP
  15.         Systems (in.smtpd or InetUtils v1.4)
  16.  
  17. SYNOPSIS
  18.  
  19.     faces
  20.  
  21. DESCRIPTION
  22.  
  23.     AmigaFaces is a program to be used as a mail filter. It can
  24.     start other programs depending on the incoming mail's sender.
  25.     Thus, you can i.e. let your Amiga sing "Halleluhjah" whenever
  26.     a mail from your girlfriend arrives or swear loudly when mail
  27.     from the company is received.
  28.     
  29.  
  30. INSTALLATION
  31.  
  32.     Copy faces somewhere in your search path. Copy faces.db to
  33.     AmiTCP:db, UULib: or S:. If you don't have one of these, you
  34.     don't have an Amiga. AmigaFaces is not for you.
  35.     
  36.     Change faces.db to suit your needs. (This file is well
  37.     commented and should be pretty self-explanatory.
  38.  
  39.     Edit your aliases file, most propably UULib:aliases or
  40.     AmiTCP:db/aliases. For every user whose mail shall be
  41.     processed by faces, add a piping entry. Example:
  42.  
  43.     foo: \foo, "|faces"
  44.  
  45.     For the ones without a sound collection of their own I have
  46.     included a "Halleluhjah" and a "DingDing" sound to have
  47.     something to start with. I strongly recommend AmiSOX, which
  48.     can be found on Aminet and converts virtually all formats to
  49.     Amiga IFF (8svx) sound.
  50.  
  51.     That's all.
  52.  
  53.  
  54. NOTES
  55.  
  56.     The way this program works is easy: It is invoked by the
  57.     rmail-type part of your mailsytem and is given the mail as
  58.     its input. It extracts the sender's EMail-address and then
  59.     looks up faces.db to see if an action is defined for this
  60.     address or class of addresses. If one was found, faces
  61.     performs the corresponding action.
  62.  
  63.     See the example faces.db for additional documentation.
  64.  
  65.  
  66. DISCLAIMER
  67.  
  68.     No cost - no warranty. Although I really can't imagine what
  69.     harm the proper or improper usage of AmigaFaces could do to
  70.     your system or data integrity, I must, of course, deny any
  71.     responsibility for incidetal or consequential damages 
  72.     whatsoever. Smile. Relax. Enjoy.
  73.  
  74.     AmigaFaces, that is all part of this distribution except for
  75.     the sounds, is Copyright 1994 by Andreas Oesterhelt. All
  76.     rights are strictly reserved. Permission is granted to
  77.     distribute and use, AS LONG AS NO PROFIT IS MADE HEREOF.
  78.     Violators will be towed ;-)
  79.  
  80.     The author can be reached on the net as oesi@paradis.rhein.de
  81.     I would be glad about your comments, greetings, curses, etc.
  82.  
  83.  
  84.  
  85. BUGS/TODO
  86.     
  87.     I have extensively tested faces with AmigaUUCP rmail, the
  88.     in.smtpd for AmiTCP 3b and shortly with SMTPd fom InetUtils
  89.     1.4. So far, no bugs are known.
  90.  
  91.     I am thinking about adding a switch for the faces.db entries
  92.     that will make piping the mailbody to a command possible. Thus
  93.     one could i.e. have messages from selected people displayed 
  94.     without entering one's mailreader.
  95.  
  96.     Also, the matching of the sender's name should become case-in-
  97.     sensitive.
  98.  
  99.     If requested, different db files for different users are
  100.     imaginable.
  101.  
  102.  
  103. DIAGNOSTICS
  104.  
  105.     To test your faces.db without requesting hundreds of people to
  106.     send mail, you can invoke faces from the command line and then
  107.     type in a From: line, terminated by Ctrl-\ (EOF). Faces will
  108.     try to execute the predefined action and errors of either
  109.     faces or the invoked application are displayed in the shell.
  110.  
  111.  
  112. ============================= Archive contents =============================
  113.  
  114. Original  Packed Ratio    Date     Time    Name
  115. -------- ------- ----- --------- --------  -------------
  116.     1870     958 48.7% 11-Dec-94 21:21:34  faces.db
  117.     3155    1671 47.0% 11-Dec-94 21:31:52  faces.man
  118.    16657   11023 33.8% 30-Nov-94 17:19:38  halleluhjah
  119.    17652    7851 55.5% 11-Dec-94 21:35:42  dingdong
  120.    10120    6373 37.0% 13-Dec-94 16:51:42  faces
  121. -------- ------- ----- --------- --------
  122.    49454   27876 43.6% 15-Dec-94 16:45:50   5 files
  123.